package com.checkCode.entity.dto;

import io.swagger.annotations.ApiModelProperty;
import io.swagger.annotations.ApiOperation;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;

/**
 * @author 大忽悠
 */
@AllArgsConstructor
@NoArgsConstructor
@Data
@Builder
@ApiOperation("验证码结果对象")
public class CheckCodeResultDto {
    /**
     * key用于验证
     */
    @ApiModelProperty("验证码key,用于验证")
    private String key;

    /**
     * 1.图片验证码为:图片base64编码
     * 2.短信验证码为:null
     * 3.邮件验证码为: null
     * 4.邮件链接点击验证为：null
     * ...
     */
    @ApiModelProperty("图片验证码场景1下,返回图片base64编码,其他情况返回null")
    private String aliasing;
}
